Package-level declarations

Types

Link copied to clipboard
class Containers(dockerClient: DockerClient)

Docker containers operations using the owning DockerClient.

Link copied to clipboard
class Exec(dockerClient: DockerClient)

Docker exec operations using the owning DockerClient.

Link copied to clipboard
class Images(dockerClient: DockerClient)

Docker images operations using the owning DockerClient.

Link copied to clipboard
class Networks(dockerClient: DockerClient)

Docker networks operations using the owning DockerClient.

Link copied to clipboard
class Swarm(dockerClient: DockerClient)

Swarm resource APIs. Accessing this group does not initialize or join a swarm. Resource operations require a manager. No operation closes the supplied client. HTTP errors return Result errors; transport/decoding failures and cancellation throw. No automatic retries.

Link copied to clipboard
class System(dockerClient: DockerClient)

Docker system operations using the owning DockerClient.

Link copied to clipboard
class Volumes(dockerClient: DockerClient)

Docker volumes operations using the owning DockerClient.

Properties

Link copied to clipboard
const val AUTH_HEADER: String
Link copied to clipboard

Cached containers API bound to this client and its connection configuration.

Link copied to clipboard
Link copied to clipboard

Cached exec API bound to this client and its connection configuration.

Link copied to clipboard

Cached images API bound to this client and its connection configuration.

Link copied to clipboard

Cached networks API bound to this client and its connection configuration.

Link copied to clipboard

Cached Swarm API using this client's endpoint and lifetime.

Link copied to clipboard

Cached system API bound to this client and its connection configuration.

Link copied to clipboard

Cached volumes API bound to this client and its connection configuration.

Functions

Link copied to clipboard
suspend fun DockerClient.auth(authConfig: AuthConfig): Result<SystemAuthResponse, ErrorResponse>

Validates registry credentials through Docker and stores successful authentication in DockerClientConfig.auth.

Link copied to clipboard

Resolve server address for registry.